Skip to content

docs(python): embedded bindings page and quickstart connection options - #503

Open
tae898 wants to merge 3 commits into
ArcadeData:mainfrom
tae898:python-embedded-bindings-page
Open

tae898 wants to merge 3 commits into
ArcadeData:mainfrom
tae898:python-embedded-bindings-page

Conversation

@tae898

@tae898 tae898 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Part of #502 (first of several small PRs).

  • New page how-to/connectivity/python-embedded.adoc: install arcadedb-embedded (and a pointer to the arcadedb-embedded-native preview), open a database in-process, query with SQL and openCypher, and when to pick it over the HTTP driver.
  • Python quickstart: the "Connection options for Python" box lists the embedded bindings; the closing "Embedded Python Bindings" section now links to the new page instead of the old repository.
  • Languages & Drivers: the Python card names the embedded bindings, a line under the cards links to the page, and generate-nav.py adds the page under Python in the sidebar.

Every claim comes from the bindings' own docs and the PyPI metadata. There are no performance numbers. The two code samples were run against the published arcadedb-embedded 26.10.2.post1 wheel and print the output shown.

Checks run locally: docs-validator.py reports the same results as on main plus one more orphan warning, because it counts only <<...>> references and not xref:; the sibling driver pages (for example python-grpc.adoc) show the same. scripts/migrate.sh && npm run build builds build/site/arcadedb/how-to/connectivity/python-embedded.html, and the sidebar and the quickstart box show the entry. The PDF build was not run.

🤖 Generated with Claude Code

…hon connection options

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@mergify

mergify Bot commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

…n native

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898

tae898 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor Author

The red "Validate Documentation" check is the same as on main (the last two Documentation Validation runs on main, 64ee576 and b9addec, fail too): 2 anchor names in reference/sql/sql-functions.adoc (cchShortestPath, duanSSSP) and 3 broken cross-references in how-to/connectivity/postgres.adoc:186, reference/settings.adoc:553 and reference/sql/chapter.adoc:66. This PR adds no error; the only change in the output is one more "potentially orphaned" warning, because the validator counts <<>> references and the new page is linked with xref:, like the other driver pages. The site build passes and shows the new page.

…b-python

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant